home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Sharing Fun! I Know My Savior Lives / Sunday Savers: Sharing Fun! I Know My Savior Lives.iso / mac / Xtras / Buddy API 3.7 / Buddy API Docs.swf / texts / 1560.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  3.8 KB  |  145 lines
  1. 142
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. GetFolder 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baGetFolder displays a directory dialog box and returns the folder selected..
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baGetFolder( StartDir, Instruction, Flags, Caption, X, Y )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. String, string, integer, string, integer, integer. 
  36. --- RECORDSEPARATOR ---
  37. StartDir is the initial directory. Use "" for the current directory. 
  38. --- RECORDSEPARATOR ---
  39. Instruction is the instruction to display to the user. 
  40. --- RECORDSEPARATOR ---
  41. Flags modifies the behaviour of the dialog. 
  42. --- RECORDSEPARATOR ---
  43. Caption is the caption of the dialog. 
  44. --- RECORDSEPARATOR ---
  45. X is the horizontal position of the dialog. 
  46. --- RECORDSEPARATOR ---
  47. Y is the vertical position of the dialog.
  48. --- RECORDSEPARATOR ---
  49.  
  50. --- RECORDSEPARATOR ---
  51. Returns:
  52. --- RECORDSEPARATOR ---
  53.  
  54. --- RECORDSEPARATOR ---
  55. String. 
  56. --- RECORDSEPARATOR ---
  57. Returns the folder selected, or "" if the user cancelled.
  58. --- RECORDSEPARATOR ---
  59.  
  60. --- RECORDSEPARATOR ---
  61. Examples:
  62. --- RECORDSEPARATOR ---
  63.  
  64. --- RECORDSEPARATOR ---
  65. Director: 
  66. --- RECORDSEPARATOR ---
  67. set folder = baGetFolder( "c:\temp", "Please select a folder to install into:", 1, 
  68. --- RECORDSEPARATOR ---
  69. "Select a folder", -1, 0 ) 
  70. --- RECORDSEPARATOR ---
  71. Authorware: 
  72. --- RECORDSEPARATOR ---
  73. folder := baGetFolder( "c:\\temp", "Select  installation directory", 0, "", 200, 200 )
  74. --- RECORDSEPARATOR ---
  75.  
  76. --- RECORDSEPARATOR ---
  77. Notes:
  78. --- RECORDSEPARATOR ---
  79.  
  80. --- RECORDSEPARATOR ---
  81. The flags argument allows you to change the way the dialog box looks and 
  82. --- RECORDSEPARATOR ---
  83. behaves. There are two values defined. 
  84. --- RECORDSEPARATOR ---
  85. 1 
  86. --- RECORDSEPARATOR ---
  87. On
  88. --- RECORDSEPARATOR ---
  89.  Windows
  90. --- RECORDSEPARATOR ---
  91. , makes the dialog box a 32 bit Explorer style. If this style is not 
  92. --- RECORDSEPARATOR ---
  93. available, for example if running under Windows 3.1, then a 16 bit style 
  94. --- RECORDSEPARATOR ---
  95. dialog will be shown. The 16 bit Xtra/UCD ignores this style - it will always 
  96. --- RECORDSEPARATOR ---
  97. show the 16 bit style dialog. 
  98. --- RECORDSEPARATOR ---
  99. On
  100. --- RECORDSEPARATOR ---
  101.  Macintosh
  102. --- RECORDSEPARATOR ---
  103. , uses Navigation Services if available. 
  104. --- RECORDSEPARATOR ---
  105. 2 
  106. --- RECORDSEPARATOR ---
  107. Displays a ΓÇÿNewΓÇÖ button to allow the user to create a new folder. On
  108. --- RECORDSEPARATOR ---
  109.  
  110. --- RECORDSEPARATOR ---
  111. Windows
  112. --- RECORDSEPARATOR ---
  113. , this style is only available with the 16 bit style dialog. It cannot be 
  114. --- RECORDSEPARATOR ---
  115. combined with Explorer style dialogs. 
  116. --- RECORDSEPARATOR ---
  117. On
  118. --- RECORDSEPARATOR ---
  119.  Macintosh
  120. --- RECORDSEPARATOR ---
  121. ,  Navigation Services dialogs will always show a New Folder 
  122. --- RECORDSEPARATOR ---
  123. button. 
  124. --- RECORDSEPARATOR ---
  125. The Caption argument is only used on
  126. --- RECORDSEPARATOR ---
  127.  Windows
  128. --- RECORDSEPARATOR ---
  129.  if a Explorer style dialog box is 
  130. --- RECORDSEPARATOR ---
  131. used. If it is an empty string, then the default "Browse for Folder" will be displayed. 
  132. --- RECORDSEPARATOR ---
  133. It is ignored on
  134. --- RECORDSEPARATOR ---
  135.  Macintosh
  136. --- RECORDSEPARATOR ---
  137. . 
  138. --- RECORDSEPARATOR ---
  139. The X and Y values are the number of pixels from the top left corner of the screen. 
  140. --- RECORDSEPARATOR ---
  141. Set X to -1 to position the dialog in the center of the calling Director/Authorware 
  142. --- RECORDSEPARATOR ---
  143. window. Set X to -2 to position the dialog in the center of the screen. 
  144. --- RECORDSEPARATOR ---
  145. Under OSX, Navigation Services will always be used.